Automatic Pix scheduling

Fetch all scheduled Automatic Pix

Request

GET 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/schedules'

Headers

Name	Description
Authorization	Required. API key

Path Parameters:

Name	Type	Description
flow	enum	Which journey to search for, values: 1, 2, 3, 4
beneficiaryDocument	string	The document of the receiver
payerPersonType	int	The type of person: 0 - Natural Person, 1 - Legal Person
payerDocument	string	The document of the sender
payerAgencyNumber	string	The bank agency number of the sender
payerAccountNumber	string	The account number of the sender
schedulingStatus	int	The status of the schedule: 0 - Accepted, 1 - Rejected
dueDateStart	date	The start date of the query
dueDateEnd	date	The end date of the query
page	number	The page number. Use this to paginate results depending on pageSize
pageSize	number	The amount of results returned per page

Response

The status code 200 indicates success in the query.

Being succeeded, the return will have the following fields in Json format:

{
    "jdpiAt": "2025-07-11T15:03:32.027",
    "schedules": [
        {
            "endToEndId": "E3822485720250610120000010000001",
            "receiverReconciliationId": "RR4002892220250429ABCDE122131",
            "scheduleStatus": "ACCEPTED",
            "acceptRejectAt": "0001-01-01T00:00:00",
            "jdpiRequestAt": "2025-06-10T16:08:21.284Z",
            "situationAt": "2025-07-11T15:03:32.027Z",
            "jdpiProcessingStatus": "PENDING_USER",
            "jdpiStatus": "PROCESSING",
            "recurrenceId": "RR4002892220250429ABCDE122131",
            "receiverPspReceptionAt": "2025-06-10T15:54:39.494Z",
            "dueDate": "2025-06-12",
            "amount": 150.75,
            "beneficiary": {
                "ispb": "38224857",
                "document": "03284584000162",
                "name": "corporateName",
                "agencyNumber": "1",
                "accountType": "PAYMENT",
                "accountNumber": "42790"
            },
            "payer": {
                "ispb": "38224857",
                "type": "NATURAL",
                "document": "05876932582",
                "agencyNumber": "1",
                "accountNumber": "42790"
            },
            "infoBetweenParties": "Contrato: Teste Alisson - Assinatura Exclusive Ultra",
            "schedulePurpose": "FIRST_ATTEMPT",
            "cancellations": [
                {
                    "cancellationId": "CA3822485720250616Jgs0xZD3uAV",
                    "requesterIspb": "38224857",
                    "recipientIspb": "38224857",
                    "cancellationRequesterType": "LEGAL",
                    "cancellationRequesterDocument": "03284584000162",
                    "cancellationReason": "REQUESTED_BY_PAYEE",
                    "cancellationAt": "2025-06-16T17:08:36.679Z",
                    "cancellationStatus": "ACCEPTED"
                }
            ]
        }
    ]
}

Cancel scheduled Automatic Pix

Request

POST 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/schedules/:endToEnd/cancel'

Headers

Name	Description
Authorization	Required. API key

Path Parameters:

Name	Type	Description
endToEndId	string	Required. Authorization identifier

Body Parameters:

{
	"CancellationRequesterType": "PAYER",
	"ReceiverIspb": "00000000",
	"RequesterIspb": "38224857",
	"CancellationReqDocument": "12345678901",
	"PayerAccountType": "NATURAL",
	"BeneficiaryConciliationId": "{{guid}}",
	"CancellationReason": "ACCOUNT_CLOSED"
}

Response

The status code 200 indicates success in the query.

Being succeeded, the return will have the following fields in Json format:

{
"endToEndId":"E11111111202409181500y6j6mt9l1pi",
"correlationId":"JDPI2024091800000000000000000000002",
"id":"CA0435879820240918bcdb1fhn43a",
"cancelDate":"2024-09-18T10:10:05.025Z"
}